Data Plane API Specification Update Pull Request

Breaking changes due to SDK Review Feedback:

Model name changes:

1006 - RemovedDefinition
1017 - ReferenceRedirection
1047 - XmsEnumChanged

• AffinityInfo -> BatchAffinityInfo
• BatchJobAction -> BatchJobActionKind
• BatchJobCreateContent -> BatchJobCreateOptions
• BatchJobDisableContent -> BatchJobDisableOptions
• BatchJobScheduleCreateContent -> BatchJobScheduleCreateOptions
• BatchJobScheduleUpdateContent -> BatchJobScheduleUpdateOptions
• BatchJobTerminateContent -> BatchJobTerminateOptions
• BatchJobUpdateContent -> BatchJobUpdateOptions
• BatchNodeDeallocateContent -> BatchNodeDeallocateOptions
• BatchNodeDisableSchedulingContent -> BatchNodeDisableSchedulingOptions
• BatchNodeRebootContent -> BatchNodeRebootOptions
• BatchNodeRebootOption -> BatchNodeRebootKind
• BatchNodeReimageContent -> BatchNodeReimageOptions
• BatchNodeRemoveContent -> BatchNodeRemoveOptions
• BatchNodeUserCreateContent -> BatchNodeUserCreateOptions
• BatchNodeUserUpdateContent -> BatchNodeUserUpdateOptions
• BatchPoolCreateContent -> BatchPoolCreateOptions
• BatchPoolEnableAutoScaleContent -> BatchPoolEnableAutoScaleOptions
• BatchPoolEvaluateAutoScaleContent -> BatchPoolEvaluateAutoScaleOptions
• BatchPoolReplaceContent -> BatchPoolReplaceOptions
• BatchPoolResizeContent -> BatchPoolResizeOptions
• BatchPoolUpdateContent -> BatchPoolUpdateOptions
• BatchTaskCreateContent -> BatchTaskCreateOptions
• ContainerConfiguration -> BatchContainerConfiguration
• ContainerConfigurationUpdate -> BatchContainerConfigurationUpdate
• DeleteBatchCertificateError -> BatchCertificateDeleteError
• DiffDiskSettings -> BatchDiffDiskSettings
• ErrorCategory -> BatchErrorSourceCategory
• ImageReference -> BatchVmImageReference
• OSDisk -> BatchOsDisk
• OnAllBatchTasksComplete -> BatchAllTasksCompleteMode
• OnBatchTaskFailure -> BatchAllTasksCompleteMode
• PublicIpAddressConfiguration -> BatchPublicIpAddressConfiguration
• UefiSettings -> BatchUefiSettings
• UploadBatchServiceLogsContent -> UploadBatchServiceLogsOptions
• VMDiskSecurityProfile -> BatchVMDiskSecurityProfile

Rename Body Parameter:

1009 - RemovedRequiredParameter
1010 - AddingRequiredParameter
1043 - AddingOptionalParameter
1046 - RemovedOptionalParameter

• /jobs/{jobId}/disable body parameters -> disableOptions
• /pools/{poolId}/enableautoscale body parameters -> enableAutoScaleOptions
• /pools/{poolId}/evaluateautoscale body parameters -> evaluateAutoScaleOptions
• /pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs body parameters -> uploadOptions
• /pools/{poolId}/nodes/{nodeId}/users/{userName} body parameters -> updateOptions
• /pools/{poolId}/removenodes body parameters ->removeOptions
• /pools/{poolId}/resize body parameters -> resizeOptions
• /jobs/{jobId}/terminate body parameters -> options
• /pools/{poolId}/nodes/{nodeId}/deallocate body parameters -> options
• /pools/{poolId}/nodes/{nodeId}/disablescheduling body parameters -> options
• /pools/{poolId}/nodes/{nodeId}/reboot body parameters -> options
• /pools/{poolId}/nodes/{nodeId}/reimage body parameters -> options

Type Changes:

1023 - TypeFormatChanged
1029 - ReadonlyPropertyChanged
1027 - DefaultValueChanged

arm-id, changed from string to arm-id :

• definitions.BatchNodeIdentityReference.properties.resourceId
• definitions.BatchUserAssignedIdentity.properties.resourceId
• definitions.BatchVmImageReference.properties.virtualMachineImageId

byte, changed from string to byte:

• definitions/BatchCertificate/properties/data

uri, changed from string to uri:

• definitions/BatchCertificate/properties/url
• definitions/BatchJob/properties/url
• definitions/ContainerRegistryReference/properties/registryServer
• definitions/ResourceFile/properties/storageContainerUrl
• definitions/ResourceFile/properties/httpUrl
• definitions/OutputFileBlobContainerDestination/properties/containerUrl
• definitions/AzureFileShareConfiguration/properties/azureFileUrl
• definitions/BatchJobStatistics/properties/url
• definitions/BatchJobPreparationAndReleaseTaskStatus/properties/nodeUrl
• definitions/BatchJobPreparationTaskExecutionInfo/properties/taskRootDirectoryUrl
• definitions/BatchJobReleaseTaskExecutionInfo/properties/taskRootDirectoryUrl
• definitions/BatchTask/properties/url
• definitions/BatchNodeInfo/properties/nodeUrl
• definitions/BatchNodeInfo/properties/taskRootDirectoryUrl
• definitions/BatchTaskStatistics/properties/url
• definitions/BatchNodeFile/properties/url
• definitions/BatchJobSchedule/properties/url
• definitions/RecentBatchJob/properties/url
• definitions/BatchJobScheduleStatistics/properties/url
• definitions/BatchPool/properties/url
• definitions/BatchPoolStatistics/properties/url
• definitions/BatchNode/properties/url
• definitions/BatchTaskInfo/properties/taskUrl

etag:

• changed eTag in every api from string to #/definitions/Azure.Core.eTag

timeout:

• change type of timeOut from int to duration, can no longer have a default value

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

• Link to API Spec engagement record issue:

Is this review for (select one):

• a private preview
• a public preview
• GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

• Design Document:
• Previous API Spec Doc:
• Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Getting help

• First, please carefully read through this PR description, from top to bottom.
• If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
• To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
• For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
  and https://aka.ms/ci-fix.
• If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
  This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
• If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.